Release notes

July 2026

Changes to company API

What changed

The Company API adds two new operations and updates existing firm operations.

    Added PUT /firms/{sigmaId}/change-activity-status: Allows updating the activity status of an existing firm.

    Added GET /firms/by-external-reference/{externalReference}: Allows retrieving a firm using its external reference instead of its Sigma ID.

    Added query parameter includeInactive to GET /firms.

    Added request field externalReference to create and update firm requests.

    Added response fields activityStatus, externalReference, and companyType.id to firm responses.

    Changed response field companyType from a UUID string to an object containing id.

    Changed several error responses to use ExceptionResponse.

Why this matters

Integrators can now find a firm by external reference, update a firm's activity status separately, filter firm searches by inactive records, and receive activity status and external-reference information in firm responses.

New attributes

    externalReference: stores or returns an external identifier for the firm.

    activityStatus: returns the firm's activity status.

    includeInactive: controls whether inactive firms are included in search results.

Affected endpoints

  • GET /firms
  • POST /firms
  • GET /firms/{sigmaId}
  • PUT /firms/{sigmaId}
  • PUT /firms/{sigmaId}/change-activity-status
  • GET /firms/by-external-reference/{externalReference}
API details

    GET /firms: new optional query parameter includeInactive, boolean, default false.

    POST /firms and PUT /firms/{sigmaId}: request model NewFirmRequestJson adds optional externalReference.

    Firm response model FirmResponseJson adds activityStatus, externalReference, and nested companyType.id.

    companyType in FirmResponseJson changed from string (uuid) to object.

    Error responses 400, 403, 404, 422, and 500 now expose ExceptionResponse in more places.

New fields

    includeInactive

    • Type: boolean
    • Nullable: false
    • Required: false
    • Description: Includes inactive firms in search results when set to true.
    • Affected endpoint: GET /firms

    externalReference

    • Type: string
    • Nullable: false
    • Required: false
    • Description: External reference for the firm.
    • Affected request model: NewFirmRequestJson
    • Affected endpoints: POST /firms, PUT /firms/{sigmaId}

    activityStatus

    • Type: string
    • Nullable: false
    • Required: true
    • Description: Activity status of the firm.
    • Affected response model: FirmResponseJson

    companyType.id

    • Type: string (uuid)
    • Nullable: false
    • Required: true
    • Description: Identifier of the company type.
    • Affected response model: FirmResponseJson

Breaking changes

Breaking changes were detected.

    companyType changed in FirmResponseJson from string (uuid) to object. This is breaking because clients that parse companyType as a string must now read companyType.id.

    422 Unprocessable Entity changed from ConstraintValidationErrorInfo to ExceptionResponse. This is breaking for clients that parse validation error fields such as method, url, violations, or constraintViolations.

YAML changes

Paths added
  • PUT /firms/{sigmaId}/change-activity-status
  • GET /firms/by-external-reference/{externalReference}
Paths removed

None.

Paths updated
  • GET /firms
  • POST /firms
  • GET /firms/{sigmaId}
  • PUT /firms/{sigmaId}
Schemas added

None.

Schemas removed

    ConstraintValidationErrorInfo

    Violation

    Legacy media-related schemas that are not exposed by the Company API contract.

Schemas updated

    NewFirmRequestJson: Added externalReference (string).

    FirmResponseJson: Added activityStatus (string), externalReference (string), and companyType.id (string (uuid)). Changed companyType from string (uuid) to object. Required changed: activityStatus from optional to required.

    ExceptionResponse: No effective field-level change.

    DropDownJson: No effective field-level change.

    PaginationSearchResultJsonFirmResponseJson: effective item model changed through FirmResponseJson.

Consult the API explorer for more details.

June 2026

Moved in BAPI KB structure

Since the companies can be used for more than one Hive application, the Content API for companies was renamed to Company API and moved to a separate folder.

October 2024

Addition of Image API and parts of related APIs

From this version on, it is possible to manage images, image rules and image specifications using the Image API.

To support this workflow, parts of the content API and drop-down API can also be used. For the content API, this concerns the calls to manage companies, while for the drop-down API, this concerns drop-down calls for languages and image types.

For more information, please see the OpenAPI definitions of the image API, content API and drop-down API.